MarkLogic 12 Product Documentation

GET /manage/v2/external-security/{id|name}

Summary

This resource address returns the specified external-security configuration.

For more information on external security, see External Security in the Security Guide.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

• the manage-admin and security role
• the following privileges:

  http://marklogic.com/xdmp/privileges/manage

  http://marklogic.com/xdmp/privileges/manage-admin

  http://marklogic.com/xdmp/privileges/external-security-get-authentication

Usage Notes

The structure of the output returned from this REST API is as follows:

id

name

description

An object's description.

authentication

Authentication

cache-timeout

An integer number of seconds, min 0, max 4294967295.

authorization

An authorization scheme.

ldap-server-uri

URI of the LDAP server. Required if authentication or authorization is LDAP.

ldap-base

starting point for search. Required if authentication or authorization is LDAP.

ldap-attribute

LDAP attribute for user lookup. Required if authentication or authorization is LDAP.

ldap-default-user

LDAP user used by MarkLogic server. Required if authentication is kerberos and authorization is LDAP or bind method is simple.

ldap-password

password of the default LDAP user. Required if authentication is kerberos and authorization is LDAP or bind method is simple.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example

http://localhost:8002/manage/v2/external-security/MyExternalName

==> Returns the configuration of the external-security, "MyExternalName,"
    in the Security database.